fix: update contributing links in README for MkDocs compatibility#259
Merged
fix: update contributing links in README for MkDocs compatibility#259
Conversation
Collaborator
|
Hi @vrajrajpura @lsetiawan ! Just want to check. This PR doesn't replace docs PR #225 or PR #204 correct? I'm catching up on these docs PR reviews and plan to merge them in #204, #225 and #259 order, being careful when reconciling with altered main. |
Collaborator
|
@Vraj1234 please respond to mei. Additionally, seems like the nav isn't quite working to the specific files, can you please investigate this? Thanks! |
Collaborator
Author
|
Hi @mglbleta , you are raight all 3 PRs serve different purposes:
I think merging them in the order you mentioned shouldnt be a problem (there are 2 merge conflicts but they are trivial) |
Collaborator
Author
|
@mglbleta No action is needed on your end, will clean up this issue & get it merged. Thanks |
Vraj1234
force-pushed
the
fix/contributing-links
branch
from
7eafad9 to
3883065
Compare
Collaborator
Author
|
@lsetiawan Ready to Merge |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
docs/README.mdis a symlink to the rootREADME.md. MkDocs resolves relative links fromdocs/as the base, so the previousdocs/CONTRIBUTING.mdlinks were resolving todocs/docs/CONTRIBUTING.md(404).docs/so they resolve correctly in the MkDocs site while keeping the symlink as the single source of truth.Test plan
pixi run -e docs docs-serveand verify all Contributing links on the home page navigate correctly